From 93f6747e78cd086570cc381a86340f2add692b59 Mon Sep 17 00:00:00 2001 From: vany5921 <908744431@qq.com> Date: Wed, 18 Mar 2020 11:01:53 +0800 Subject: [PATCH] update docs format --- docs/en/1515/6060-push.md | 9 +-- docs/en/1515/ap.md | 4 +- docs/en/1515/connectors.md | 6 -- docs/en/1515/corner.md | 3 +- docs/en/1515/nut.md | 4 +- docs/en/accessory/485t.md | 10 --- docs/en/accessory/cable/grove_cable.md | 9 +-- docs/en/accessory/cable/lego_cable.md | 14 +--- docs/en/accessory/converter/grove2grove.md | 2 - docs/en/accessory/converter/grove_t.md | 3 - docs/en/accessory/glass_panel_repair_kit.md | 5 +- docs/en/base/m5go_rfid.md | 13 ++-- docs/en/core/atom_lite.md | 29 ++------- docs/en/core/atom_matrix.md | 29 ++------- docs/en/core/basic.md | 5 +- docs/en/core/face_kit.md | 24 +------ docs/en/core/fire.md | 57 +++-------------- docs/en/core/gray.md | 2 +- docs/en/core/m5go.md | 39 +++-------- docs/en/core/m5go_lite.md | 11 ++-- docs/en/core/m5stick.md | 6 +- docs/en/core/m5stickc.md | 54 ++++------------ docs/en/core/m5stickt.md | 25 ++------ docs/en/core/m5stickv.md | 20 +----- docs/index.md | 1 + docs/zh_CN/1515/6060-push.md | 3 +- docs/zh_CN/1515/ap.md | 4 +- docs/zh_CN/1515/connectors.md | 3 - docs/zh_CN/1515/corner.md | 7 +- docs/zh_CN/1515/nut.md | 4 +- docs/zh_CN/README.md | 1 + docs/zh_CN/accessory/485t.md | 8 +-- docs/zh_CN/accessory/battery_base.md | 9 +-- docs/zh_CN/accessory/bus_socket.md | 7 +- docs/zh_CN/accessory/cable/grove_cable.md | 4 +- docs/zh_CN/accessory/cable/lego_cable.md | 15 ++--- docs/zh_CN/accessory/converter/grove2grove.md | 10 +-- docs/zh_CN/accessory/converter/grove_t.md | 10 +-- docs/zh_CN/accessory/frame.md | 19 +----- .../zh_CN/accessory/glass_panel_repair_kit.md | 15 +---- docs/zh_CN/accessory/screw.md | 16 +---- docs/zh_CN/accessory/sg90_servo.md | 16 +---- docs/zh_CN/accessory/watch.md | 10 +-- docs/zh_CN/app/ac_socket.md | 12 +--- docs/zh_CN/app/bala.md | 13 +--- docs/zh_CN/app/demo-board.md | 11 +--- docs/zh_CN/app/flir.md | 16 +---- docs/zh_CN/app/lidarbot.md | 10 +-- docs/zh_CN/app/m5scale_diy_kit.md | 53 +-------------- docs/zh_CN/app/piano.md | 14 +--- docs/zh_CN/base/base15.md | 15 +---- docs/zh_CN/base/base26.md | 15 +---- docs/zh_CN/base/basex.md | 13 +--- docs/zh_CN/base/btc_base.md | 40 +----------- docs/zh_CN/base/core_bottom.md | 10 +-- .../base/iiot_dual_switch_kit_with_core.md | 21 ++---- docs/zh_CN/base/lan_base.md | 12 ++-- docs/zh_CN/base/m5go_bottom.md | 10 +-- docs/zh_CN/base/m5go_charger.md | 9 +-- docs/zh_CN/base/m5go_rfid.md | 18 +++--- docs/zh_CN/base/node_base.md | 10 +-- docs/zh_CN/base/plc_base.md | 17 +---- docs/zh_CN/base/pm2.5.md | 26 ++------ docs/zh_CN/core/m5go_lite.md | 2 +- docs/zh_CN/core/m5stickv.md | 1 - docs/zh_CN/hat/hat-18650.md | 10 +-- docs/zh_CN/hat/hat-8servos.md | 21 ++---- docs/zh_CN/hat/hat-adc.md | 64 ++----------------- docs/zh_CN/hat/hat-beetlec.md | 16 ++--- docs/zh_CN/hat/hat-bugc.md | 25 +++----- 70 files changed, 189 insertions(+), 840 deletions(-) diff --git a/docs/en/1515/6060-push.md b/docs/en/1515/6060-push.md index db0e6f67..6610faf6 100644 --- a/docs/en/1515/6060-push.md +++ b/docs/en/1515/6060-push.md @@ -1,8 +1,6 @@ # Module 6060-PUSH {docsify-ignore-all} -     - - +
@@ -11,6 +11,9 @@ M5GO Base is composed of battery(330mAh), M-Bus interface, charging indicator(red led), **RFID coil**, **IR transmitter**, two RGB Bar, PORT B and PORT C. + + + ## Include - 1x M5GO RFID @@ -75,18 +78,14 @@ Analog Microphone **M-Bus** -M_BUS + ## Related Link -- **[M5GO IOT Starter Kit Purchase Link](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.2.52385ab04i7vIu)** - - **[MFRC522](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/base/RC522_EN.pdf)** - - @@ -12,14 +12,6 @@ Every M5stack development kit can be programmed through Arduino IDE, WebIDE UIFl This M5GO kit is specifically designed for STEM education. The pack includes 1 M5GO conroller + 6 M5units + plenty of accessories. Having all those goods, together with the Blockly program platform, allows the school students to explore the engineering world , making their own IoT product and implement brilliant ideas into real life. -**Notice:** - -The newly-produced M5Core replaces the screen with better display performance and higher viewing angle, so it has some compatibility problems with the old Arduino library. When using the old library for screen driving, it will produce reverse color display. You can open the Arduino. The library management option will upgrade your M5Stack library to the latest version (after 0.2.8) to solve this problem. - - -


- - ## Product Features - 5V DC power supply @@ -38,25 +30,10 @@ The newly-produced M5Core replaces the screen with better display performance an - Product Size：54.2mm x 54.2mm x 17.9mm - Product weight：224.9g - -### ESP32 Features - -- 240 MHz dual core Tensilica LX6 microcontroller with 600 DMIPS -- Integrated 520 KB SRAM -- Integrated 802.11b/g/n HT40 Wi-Fi transceiver, baseband, stack and LWIP -- Integrated dual mode Bluetooth (classic and BLE) -- Hall sensor -- 10x capactive touch interface -- 32 kHz crystal oscillator -- PWM/timer input/output available on every GPIO pin -- SDIO master/salve 50MHz -- SD-card interface support - ### M5GO Bottom [Click to view details parameters](en/base/m5go_bottom) - ## EasyLoader >EasyLoader is a concise and fast program writer, which has a built-in case program related to the product. It can be burned to the main control by simple steps to perform a series of function verification. Please install the corresponding driver according to the device type. M5Core host [Please click here to view the CP210X driver installation tutorial](en/arduino/arduino_development), M5StickC/V/T/ATOM series can be used without driver) @@ -89,8 +66,8 @@ The newly-produced M5Core replaces the screen with better display performance an **LCD & TF card** -*LCD ：320x240* -*TF card Maximum size 16GB* +LCD ：320x240 +TF card Maximum size 16GB @@ -108,9 +85,9 @@ The newly-produced M5Core replaces the screen with better display performance an **GROVE Port A & IP5306** -*We've use the customized I2C version of IP5306, on power management.* +We've use the customized I2C version of IP5306, on power management. -*Its I2C address is 0x75. Click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/IIC_IP5306_REG_V1.4.pdf) to check its datasheet* +Its I2C address is 0x75. Click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/IIC_IP5306_REG_V1.4.pdf) to check its datasheet.
ESP32 ChipGPIO23GPIO19GPIO18GPIO14GPIO27GPIO33GPIO32GPIO4
@@ -156,7 +133,7 @@ The newly-produced M5Core replaces the screen with better display performance an **6-Axis MotionTracking Sensor MPU6886** -*MPU6886 I2C address 0x68* +MPU6886 I2C address 0x68
ESP32 ChipGPIO22GPIO215VGND
@@ -165,7 +142,7 @@ The newly-produced M5Core replaces the screen with better display performance an **3-Axis Geomagnetic Sensor BMM150** -*BMM150 I2C address 0x10* +BMM150 I2C address 0x10
ESP32 ChipGPIO22GPIO215VGND
@@ -297,7 +274,7 @@ To complete schematic, click [here](https://github.com/m5stack/M5-Schematic/tree ## Schematic -- **Schematic** - [BASIC](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf) +- **Schematic** - [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 7a9c9142..41bea682 100644 --- a/docs/en/core/m5go_lite.md +++ b/docs/en/core/m5go_lite.md @@ -1,6 +1,6 @@ # M5GO Lite {docsify-ignore-all} - +
## DESCRIPTION @@ -60,7 +60,6 @@ The newly-produced M5Core replaces the screen with better display performance an - ## PinMap ### Peripherals Pin Map @@ -88,7 +87,7 @@ TF card Maximum size 16GB We've use the customized I2C version of IP5306, on power management. -It's I2C address is 0x75. Click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/IIC_IP5306_REG_V1.4.pdf) to check its datasheet +It's I2C address is 0x75. Click [here](https://github.com/m5stack/M5-Schematic/blob/master/Core/IIC_IP5306_REG_V1.4.pdf) to check its datasheet.
ESP32 ChipGPIO22GPIO215VGND
@@ -249,8 +248,6 @@ For more information about Pin assignment and Pin Remapping, Please refer to EPS - 1x Type-C USB(20cm) - 1x User Manual -gray_02gray_04 - ## Related Link - **Datasheet** @@ -263,9 +260,9 @@ For more information about Pin assignment and Pin Remapping, Please refer to EPS - [IP5306](https://m5stack.oss-cn-shenzhen.aliyuncs.com/resource/docs/datasheet/core/IIC_IP5306_REG_V1.4_cn.pdf) - ## Schematic +## Schematic -- **Schematic** - [BASIC](https://github.com/m5stack/M5-Schematic/blob/master/Core/Basic/M5-Core-Schematic(20171206).pdf) +- **Schematic** - [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 5e90ae5b..542522d5 100644 --- a/docs/en/core/m5stick.md +++ b/docs/en/core/m5stick.md @@ -1,7 +1,6 @@ # M5Stick {docsify-ignore-all} -gray_02 -gray_02 +
## Description @@ -78,7 +77,6 @@ M5stick is one of the core devices in M5Stack product series which is built in a - ## PinMap ### Peripheral Pin Mapping @@ -151,7 +149,6 @@ M5stick is one of the core devices in M5Stack product series which is built in a
ESP32 ChipGPIO22GPIO215VGND
9-Axis posture sentsor: MPU9250SCLSDA
- ## Include - 1x M5Stick @@ -196,7 +193,6 @@ To complete schematic, click [here](https://github.com/m5stack/M5-Schematic/tree - [White square game](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Core/M5Stick/UIFlow) - ## Video - **m5stick Case - Remote control air conditioner** diff --git a/docs/en/core/m5stickc.md b/docs/en/core/m5stickc.md index 104f12dd..97c5d5ba 100644 --- a/docs/en/core/m5stickc.md +++ b/docs/en/core/m5stickc.md @@ -1,7 +1,6 @@ # M5StickC {docsify-ignore-all} - - +
## Description @@ -24,10 +23,6 @@ M5stickC is one of the core devices in M5Stack product series which is built in * Only Orange type is available for now - - - - **Notice:** M5StickC only supports WIN10 & Linux & MAC free drive, the rest of the operating system requires users to install the driver. @@ -57,21 +52,6 @@ Installation steps: 1. Click the link below to download the driver installation - Product Size：48.2mm x 25.5mm x 13.7mm - Product weight：15.1g - - - - -## ESP32 Features - -- 240 MHz dual core Tensilica LX6 microcontroller with 600 DMIPS -- Integrated 520 KB SRAM -- Integrated 802.11b/g/n HT40 Wi-Fi transceiver, baseband, stack and LWIP -- Integrated dual mode Bluetooth (classic and BLE) -- Hall sensor -- 32 kHz crystal oscillator -- PWM/timer input/output available on every GPIO pin -- SD-card interface support - ## EasyLoader >EasyLoader is a concise and fast program writer, which has a built-in case program related to the product. It can be burned to the main control by simple steps to perform a series of function verification. Please install the corresponding driver according to the device type. M5Core host [Please click here to view the CP210X driver installation tutorial](en/arduino/arduino_development), M5StickC/V/T/ATOM series can be used without driver) @@ -98,7 +78,6 @@ Installation steps: 1. Click the link below to download the driver installation - ## Schematic @@ -125,9 +104,9 @@ Power structure block diagram **TFT LCD** -*Driver IC：ST7735S* +Driver IC：ST7735S -*Resolution：80 * 160* +Resolution：80 * 160 @@ -215,30 +194,21 @@ Power structure block diagram ## Example -* **Arduino** +**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** + +For a tutorial on uiflow, see [here](https://docs.m5stack.com/#/en/uiflow/uiflow_home_page) ## Video -- **M5StickC Case - counter** - - - -- **M5StickC Case - Safe system** - - - +cript> \ No newline at end of file + \ No newline at end of file diff --git a/docs/zh_CN/hat/hat-bugc.md b/docs/zh_CN/hat/hat-bugc.md index 9bc01fb3..ef5ec9f7 100644 --- a/docs/zh_CN/hat/hat-bugc.md +++ b/docs/zh_CN/hat/hat-bugc.md @@ -1,18 +1,12 @@ -# BugC {docsify-ignore-all} - - - - +# BugC +
## 描述 -**BugC**是一款兼容M5StickC的可编程机器人底座，底座主要部分由四路电机驱动器、四路直流电机、控制芯片为STM32F030F4、2个可编程RGB LED以及电池座和独立开关等部件组成，外观小巧运动灵活. +**BugC** 是一款兼容M5StickC的可编程机器人底座，底座主要部分由四路电机驱动器、四路直流电机、控制芯片为STM32F030F4、2个可编程RGB LED以及电池座和独立开关等部件组成，外观小巧运动灵活. Bugc底座需要结合M5StickC控制器使用.在底座上，配备了四个由STM32F030驱动的直流减速电机，电路连接至M5StickC的顶部插槽，通过I2C协议(0x38)通信，最终实现控制. - - - ## 产品特性 - 可编程机器人 @@ -23,7 +17,6 @@ Bugc底座需要结合M5StickC控制器使用.在底座上，配备了四个由S - 配备电池底座 - 运动灵活 - ## 外形尺寸和重量 - 尺寸：55mm * 40mm * 25mm @@ -38,7 +31,6 @@ Bugc底座需要结合M5StickC控制器使用.在底座上，配备了四个由S - 堵转电流: 70mA - 绝缘电阻: 10MΩ - ## 应用 - 远程电机控制 @@ -54,11 +46,11 @@ Bugc底座需要结合M5StickC控制器使用.在底座上，配备了四个由S - + ->EasyLoader is a simple and fast program burner. Every product page in EasyLoader provides a product-related case program. It can be burned to the M5 device through simple steps, and a series of function verification can be performed. +>1.EasyLoader是一个简洁快速的程序烧录器，每一个产品页面里的EasyLoader都提供了一个与产品相关的案例程序，通过简单步骤将其烧录至主控，能够进行一系列的功能验证.**(目前EasyLoader仅适用于Windows操作系统)** ->2. After downloading the software, double-click to run the application, connect the M5 device to the computer through the data cable, select the port parameters,click **"Burn"** to burn the program (**For M5StickC, set the baud rate to 750000 or 115200**) +>2.下载软件后，双击运行应用程序，将M5设备通过数据线连接至电脑,选择端口参数，点击 **"Burn"** 即可开始烧录.(**为M5StickC烧录时，请将波特率设置在750000或115200**) ## 案例程序 @@ -66,9 +58,9 @@ Bugc底座需要结合M5StickC控制器使用.在底座上，配备了四个由S -**Arduino** +- **Arduino** -*To get complete code, please click [here](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/BugC/bugC)* +[点击此处](https://github.com/m5stack/M5-ProductExampleCodes/tree/master/Hat/BugC/bugC)获取完整代码 ## 相关视频 @@ -76,7 +68,6 @@ Bugc底座需要结合M5StickC控制器使用.在底座上，配备了四个由S -
ESP32 GPIO15GPIO13GPIO23GPIO18GPIO5