From cb03932f91807feef217daf8ef52711d8f953797 Mon Sep 17 00:00:00 2001 From: watson134 <854410664@qq.com> Date: Mon, 5 Nov 2018 01:37:49 +0800 Subject: [PATCH] add chinese docs --- .../applications/application_lidarbot.md | 0 docs/en/related_documents.md | 11 +++ ...firmware_en.md => how_to_burn_firmware.md} | 0 docs/sidebar.md | 1 + docs/zh_CN/product_documents.md | 36 +++---- .../applications/application_lidarbot.md | 0 .../product_documents/units/unit_396port.md | 14 +-- .../zh_CN/product_documents/units/unit_adc.md | 10 +- .../product_documents/units/unit_angle.md | 9 +- .../product_documents/units/unit_button.md | 16 +-- .../units/unit_color_sensor.md | 32 +++--- docs/zh_CN/related_documents.md | 11 +++ .../establish_serial_connection.md | 97 +++++++++++++++++++ .../related_documents/how_to_burn_firmware.md | 71 ++++++++++++++ .../how_to_connect_wifi_using_core.md | 56 +++++++++++ .../how_to_install_git_and_arduino.md | 23 +++++ .../related_documents/upgrade_m5stack_lib.md | 17 ++++ docs/zh_CN/sidebar.md | 1 + 18 files changed, 342 insertions(+), 63 deletions(-) create mode 100644 docs/en/product_documents/applications/application_lidarbot.md create mode 100644 docs/en/related_documents.md rename docs/en/related_documents/{how_to_burn_firmware_en.md => how_to_burn_firmware.md} (100%) create mode 100644 docs/zh_CN/product_documents/applications/application_lidarbot.md create mode 100644 docs/zh_CN/related_documents.md create mode 100644 docs/zh_CN/related_documents/establish_serial_connection.md create mode 100644 docs/zh_CN/related_documents/how_to_burn_firmware.md create mode 100644 docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md create mode 100644 docs/zh_CN/related_documents/how_to_install_git_and_arduino.md create mode 100644 docs/zh_CN/related_documents/upgrade_m5stack_lib.md diff --git a/docs/en/product_documents/applications/application_lidarbot.md b/docs/en/product_documents/applications/application_lidarbot.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/en/related_documents.md b/docs/en/related_documents.md new file mode 100644 index 00000000..676adaef --- /dev/null +++ b/docs/en/related_documents.md @@ -0,0 +1,11 @@ +# Related Documents + +### [1. Establish Serial Connection](en/related_documents/establish_serial_connection) + +### [2. How to Burn Firmware](en/related_documents/how_to_burn_firmware_en) + +### [3. How to Connect WiFi Using Core](en/related_documents/how_to_connect_wifi_using_core) + +### [4. How to Install Git and Arduino](en/related_documents/how_to_install_git_and_arduino) + +### [5. Upgrade M5Stack Lib](en/related_documents/upgrade_m5stack_lib) diff --git a/docs/en/related_documents/how_to_burn_firmware_en.md b/docs/en/related_documents/how_to_burn_firmware.md similarity index 100% rename from docs/en/related_documents/how_to_burn_firmware_en.md rename to docs/en/related_documents/how_to_burn_firmware.md diff --git a/docs/sidebar.md b/docs/sidebar.md index ea8962d6..722a6beb 100644 --- a/docs/sidebar.md +++ b/docs/sidebar.md @@ -2,6 +2,7 @@ - [Quick Start](en/quick_start) - [API Rreference](en/api_reference) - [M5Stack Cases](en/m5stack_cases) +- [Related Documents](en/related_documents) - [FAQ](en/faq) diff --git a/docs/zh_CN/product_documents.md b/docs/zh_CN/product_documents.md index 307c589e..accf4f3c 100644 --- a/docs/zh_CN/product_documents.md +++ b/docs/zh_CN/product_documents.md @@ -27,7 +27,7 @@ | / | / | / | -- [M5GO底座](zh_CN/product_documents/bases/cables/m5go_base) +- [M5GO底座](zh_CN/product_documents/bases/m5go_base) - [PLC底座](zh_CN/product_documents/modules/module_plc) - [FACE底座](zh_CN/product_documents/modules/module_face) - [LAN底座](zh_CN/product_documents/bases/lan_base) @@ -44,21 +44,21 @@ | 输入/传感类Unit | 输出/控制类Unit | 接口类Unit | | :-------------------: |:------------------------: | :----------------:| -| [ENV](product_documents/units/unit_env) | [RGB](product_documents/units/unit_rgb) | [HUB](product_documents/units/unit_hub) | -| [IR](product_documents/units/unit_ir) | [RELAY](product_documents/units/unit_relay) | [3.96PORT](product_documents/units/unit_396port) | -| [PIR](product_documents/units/unit_pir) | [NeoPixel](product_documents/units/unit_neopixel) | / | -| [ANGLE](product_documents/units/unit_angle) | / | / | -| [EARTH/Moisture](product_documents/units/unit_moisture) | / | / | -| [LIGHT](product_documents/units/unit_light) | / | / | -| [MAKEY](product_documents/units/unit_makey) | / | / | -| [BUTTON](product_documents/units/unit_button) | / | / | -| [Dual-BUTTON](product_documents/units/unit_dual_button) | / | / | -| [JOYSTICK](product_documents/units/unit_joystick) | / | / | -| [THERMAL](product_documents/units/unit_thermal) | / | / | -| [ADC](product_documents/units/unit_ADC) | / | / | -| [DAC](product_documents/units/unit_DAC) | / | / | -| [Color Sensor](product_documents/units/unit_color_sensor) | / | / | -| [ToF](product_documents/units/unit_tof) | / | / | +| [ENV](zh_CN/product_documents/units/unit_env) | [RGB](zh_CN/product_documents/units/unit_rgb) | [HUB](zh_CN/product_documents/units/unit_hub) | +| [IR](zh_CN/product_documents/units/unit_ir) | [RELAY](zh_CN/product_documents/units/unit_relay) | [3.96PORT](zh_CN/product_documents/units/unit_396port) | +| [PIR](zh_CN/product_documents/units/unit_pir) | [NeoPixel](zh_CN/product_documents/units/unit_neopixel) | / | +| [ANGLE](zh_CN/product_documents/units/unit_angle) | / | / | +| [EARTH/Moisture](zh_CN/product_documents/units/unit_moisture) | / | / | +| [LIGHT](zh_CN/product_documents/units/unit_light) | / | / | +| [MAKEY](zh_CN/product_documents/units/unit_makey) | / | / | +| [BUTTON](zh_CN/product_documents/units/unit_button) | / | / | +| [Dual-BUTTON](zh_CN/product_documents/units/unit_dual_button) | / | / | +| [JOYSTICK](zh_CN/product_documents/units/unit_joystick) | / | / | +| [THERMAL](zh_CN/product_documents/units/unit_thermal) | / | / | +| [ADC](zh_CN/product_documents/units/unit_ADC) | / | / | +| [DAC](zh_CN/product_documents/units/unit_DAC) | / | / | +| [Color Sensor](zh_CN/product_documents/units/unit_color_sensor) | / | / | +| [ToF](zh_CN/product_documents/units/unit_tof) | / | / | @@ -66,9 +66,9 @@ -- [BALA](product_documents/applications/application_bala) +- [BALA](zh_CN/product_documents/applications/application_bala) -- [M5Stack USB Downloader](product_documents/tools/tool_usb_downloader) +- [M5Stack USB Downloader](zh_CN/product_documents/tools/tool_usb_downloader) diff --git a/docs/zh_CN/product_documents/applications/application_lidarbot.md b/docs/zh_CN/product_documents/applications/application_lidarbot.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/zh_CN/product_documents/units/unit_396port.md b/docs/zh_CN/product_documents/units/unit_396port.md index 933852d2..f70812e5 100644 --- a/docs/zh_CN/product_documents/units/unit_396port.md +++ b/docs/zh_CN/product_documents/units/unit_396port.md @@ -1,17 +1,17 @@ # Unit 3.96port -## DESCRIPTION +## 描述 -The Unit 3.96port is a unit that aim to transfer GROVE interface to VH3.96-4Pin. +3.96port是一个GROVE接口转VH3.96-4Pin接口的适配模块. 如果你想外接VH3.96-4Pin接口的设备的话，最好使用上这个Unit，会更加方便. -## FEATURES +## 特性 -- VH3.96 interface -- Two Lego installation holes +- VH3.96接口 +- Unit上配置两个乐高安装孔 -## DOCUMENTS +## 文档 - - [Purchase](https://www.aliexpress.com/store/3226069?spm=2114.search0104.3.5.66051a4dlpB2ti) +- **[旗舰店](https://www.aliexpress.com/store/3226069?spm=2114.search0104.3.5.66051a4dlpB2ti)**
diff --git a/docs/zh_CN/product_documents/units/unit_adc.md b/docs/zh_CN/product_documents/units/unit_adc.md index b2a3a540..a413048d 100644 --- a/docs/zh_CN/product_documents/units/unit_adc.md +++ b/docs/zh_CN/product_documents/units/unit_adc.md @@ -19,15 +19,11 @@ ## 文档 DOCUMENTS -- GitHub +- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/ADC_ADS1100) - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/ADC_ADS1100) +- **Datasheet** - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) -- Datasheet - - - [ADS1100](http://pdf1.alldatasheet.com/datasheet-pdf/view/619024/TI1/ADS1100.html) - -- [Purchase]() +- **[Purchase]()**
diff --git a/docs/zh_CN/product_documents/units/unit_angle.md b/docs/zh_CN/product_documents/units/unit_angle.md index 319ee941..87391814 100644 --- a/docs/zh_CN/product_documents/units/unit_angle.md +++ b/docs/zh_CN/product_documents/units/unit_angle.md @@ -2,17 +2,16 @@ ## DESCRIPTION -The Unit ANGLE is a potentiometer sensor that can detect rotary -angle. +ANGLE是一个电位器Unit，通过这个Unit可以检测手动旋转的角度. ## FEATURES -- Two Lego installation holes +- Unit上配置两个乐高安装孔 ## DOCUMENTS -- [GitHub](https://github.com/m5stack/M5GO) -- [Purchase](https://www.aliexpress.com/store/3226069?spm=2114.search0104.3.5.66051a4dlpB2ti) +- **[GitHub]()** +- **[Purchase](https://www.aliexpress.com/store/3226069?spm=2114.search0104.3.5.66051a4dlpB2ti)**
diff --git a/docs/zh_CN/product_documents/units/unit_button.md b/docs/zh_CN/product_documents/units/unit_button.md index 68990879..859f8ff2 100644 --- a/docs/zh_CN/product_documents/units/unit_button.md +++ b/docs/zh_CN/product_documents/units/unit_button.md @@ -1,18 +1,18 @@ # Unit BUTTON -## DESCRIPTION +## 描述 -The Unit BUTTON is a sigle-button unit that can be detected whether the button pressed or not +BUTTON是一个单按键unit，这个Unit能检测你是否按下了. -## FEATURES +## 特性 -- Two Lego installation holes -- GROVE Interface +- Unit上配置两个乐高安装孔 +- GROVE接口 -## DOCUMENTS +## 文档 -- [GitHub](https://www.m5stack.com) -- [Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Button-Unit-for-ESP32-Arduino-Micropython-Development-Kit-with-GROVE-GPIO-Port-Blockly/3226069_32921805637.html?spm=a2g1x.12024536.productList_2187621.8) +- **[GitHub]()** +- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Mini-Button-Unit-for-ESP32-Arduino-Micropython-Development-Kit-with-GROVE-GPIO-Port-Blockly/3226069_32921805637.html?spm=a2g1x.12024536.productList_2187621.8)**
diff --git a/docs/zh_CN/product_documents/units/unit_color_sensor.md b/docs/zh_CN/product_documents/units/unit_color_sensor.md index e217353c..45878613 100644 --- a/docs/zh_CN/product_documents/units/unit_color_sensor.md +++ b/docs/zh_CN/product_documents/units/unit_color_sensor.md @@ -1,33 +1,29 @@ # Unit COLOR -## DESCRIPTION +## 描述 -This is a unit can detecte the color of object surface which integrates TCS3472 (a color sensor). The unit comunicates with M5Core with I2C. +Color是一个颜色传感器. 通过GROVE接口(I2C)与M5Core相连，能够识别物体表面颜色，它内置了颜色传感器芯片TCS3472. -## FEATURES +## 特性 -- High precision -- Detection range: -70℃~382.2℃ -- Two Lego installation holes +- 高精度 +- 检测的适用温度范围: -70℃~382.2℃ +- Unit上配置两个乐高安装孔 -## APPLICATION +## 应用 -- RGB LED Backlight Control -- Product Color Verification +- RGB LED背光灯控制 +- 产品颜色验证 -## DOCUMENTS +## 文档 -- GitHub +- **GitHub** - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Color) - - [Arduino](https://github.com/m5stack/M5Stack/tree/master/examples/Unit/Color) +- **Datasheet** - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) -- Datasheet +- **[Schematic]()** - - [TCS3472](https://pdf1.alldatasheet.com/datasheet-pdf/view/560511/AMSCO/TCS3472.html) - -- [Schematic](https://github.com/m5stack/M5Stack) - -- [Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Color-Unit-TCS34725-Color-Sensor-RGB-Color-Sensor-Development-Board-Module-GROVE-I2C-Compatible/3226069_32946957647.html?spm=a2g1x.12024536.productList_5885013.pic_5) +- **[Purchase](https://www.aliexpress.com/store/product/M5Stack-Official-Color-Unit-TCS34725-Color-Sensor-RGB-Color-Sensor-Development-Board-Module-GROVE-I2C-Compatible/3226069_32946957647.html?spm=a2g1x.12024536.productList_5885013.pic_5)**
diff --git a/docs/zh_CN/related_documents.md b/docs/zh_CN/related_documents.md new file mode 100644 index 00000000..be3ebbe0 --- /dev/null +++ b/docs/zh_CN/related_documents.md @@ -0,0 +1,11 @@ +# 相关文档 + +### [1. 如何安装USB驱动并建立与PC的串口通讯](zh_CN/related_documents/establish_serial_connection) + +### [2. 如何通过M5Burner烧录固件](zh_CN/related_documents/how_to_burn_firmware) + +### [3. 如何使用M5Core连接可联网的WiFi热点](zh_CN/related_documents/how_to_connect_wifi_using_core) + +### [4. 如何安装Git和Arduino](zh_CN/related_documents/how_to_install_git_and_arduino) + +### [5. 如何更新Arduino-M5Stack库](zh_CN/related_documents/upgrade_m5stack_lib) diff --git a/docs/zh_CN/related_documents/establish_serial_connection.md b/docs/zh_CN/related_documents/establish_serial_connection.md new file mode 100644 index 00000000..6e471e90 --- /dev/null +++ b/docs/zh_CN/related_documents/establish_serial_connection.md @@ -0,0 +1,97 @@ +# 如何安装USB驱动并建立与PC的串口通讯 + +**这个文档会介绍如何安装USB驱动，并与PC建立串口通信.** + +## For MacOS + +### 1. 安装USB驱动 + +**[下载SiLabs CP2104驱动](https://www.silabs.com/documents/public/software/Mac_OSX_VCP_Driver.zip)** + +**如果镜像文件SiLabsUSBDriverDisk.dmg已经下载了, 挂载它, 根据以下图片显示的步骤来安装.** + +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +
+ +### 2. 在MacOS上检查确认COM串口号 + +**打开终端terminal并执行以下命令两次, 第一次在板子或者dongle还未插入PC的时候, 然后把板子或者dongle插入执行第二次. 这时候，在执行第二次命令之后，出现的串口号就是此时板子与PC相连的串口号** + +**MacOS** + + ls /dev/cu.* + + + +## For Windows + +### 1. 安装USB驱动 + +**下载[SiLabs CP2104驱动](https://www.silabs.com/products/development-tools/software/usb-to-uart-bridge-vcp-drivers)** + +**根据你windows版本来下载对应版本的USB驱动(Windows7/8/10).** + +
+ +
+ +**选择正确的版本来安装，如果电脑系统是32位，则下载符合Windows版本的X86版本USB驱动，如果电脑系统是64位，则下载符合Windows版本的X64版本USB驱动, 然后安装驱动.** + +
+ +
+ +
+ +
+ +
+ +
+ +### 2. 在Windows上检查确认COM串口号 + +**在Windows的设备管理器上查看COM串口号. 插上板子或者dongle之后，查看显示的COM口，再拔掉，此时消失的COM口就是该板子或dongle对应的COM口.** + +**下图显示了M5Core板子与PC通信的COM串口号** + +
+ +
diff --git a/docs/zh_CN/related_documents/how_to_burn_firmware.md b/docs/zh_CN/related_documents/how_to_burn_firmware.md new file mode 100644 index 00000000..8fa0030a --- /dev/null +++ b/docs/zh_CN/related_documents/how_to_burn_firmware.md @@ -0,0 +1,71 @@ +# 如何通过M5Burner烧录固件 + +**这个文档会介绍如何下载M5Burner，并通过M5Burner烧录固件.** + +## For MacOS + +***(在编辑中...)*** + +## For Windows + +### 1. 下载最新的M5Burner + +访问[官网](http://www.m5stack.com)来下载M5Burner. + +
+ Screenshot of coverpage +
+ +### 2. 烧录固件 + +解压刚刚下载的M5Burner压缩包, 然后双击`M5Burner.exe`. + +
+ Screenshot of coverpage +
+ + +**选择板子正与PC相连的`串口号`和`921600 波特率` .** + +
+ Screenshot of coverpage +
+ +!> **注意** 如何M5Burner的串口号选项框没有显示任何的`COMx`号或者只显示`COM1`, 这时候你需要参考这篇文档[建立串口通信](related_documents/establish_serial_connection)来重新安装USB驱动. + +**a. 选择合适的固件文件** + +a. 如果你想通过[M5Flow](http://flow.m5stack.com)来编程的话，请选择最新的`M5Flow-vx.x` + +b. 如果你想有ESP32CAM (或 M5CAMERA)，并且想编程它的话，请选择最新版的`M5Cam-vx.x (/M5Cam-psram)` + +**b. 点击`Erase`** + +
+ Screenshot of coverpage +
+ +*如果M5Burner打印出这样的信息的话`Hard resetting via RTS pin...`，这就表明你擦除固件成功了.* + +
+ Screenshot of coverpage +
+ +**c. 点击`Burn`** + +
+ Screenshot of coverpage +
+ +*如果M5Burner打印出这样的信息的话`Leaving... Staying in bootloader.`，这就表明你烧录固件成功了.* + +
+ Screenshot of coverpage +
+ +### 3. 然后重启板子 + +?> **提示** +如果M5Burner在点击`Burn`之后，显示`busy...`, 也就是卡顿的话，不要慌张，稍微等几分钟，软件自然就会烧录成功。 + +?> **提示** 如果M5Burner在擦除或者烧录过程中被中断了(如突然关闭软件), 为了保证板子能正常工作，你最好重新擦除和烧录一遍固件. \ No newline at end of file diff --git a/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md new file mode 100644 index 00000000..0109acef --- /dev/null +++ b/docs/zh_CN/related_documents/how_to_connect_wifi_using_core.md @@ -0,0 +1,56 @@ +# How to Connect WIFI Using Core + +?> **Tip** *If your M5Stack Core was not burnt with a specific firmware named `M5Flow` in advance, please visit this article [How to burn firmware](how_to_burn_firmware_en) for burnning)* + +**After powering on Core and pressing the red button on the left hand side of the M5，you will be greeted by this screen. Let's connect to networkable AP.** + +
+ +
+ +## CONTENT + +1. [Press UPLOAD Button](#press-upload-button) + +2. [Select Networkable AP](#select-networkable-ap) + +3. [Reset Your Device](#reset-your-device) + + +## 1. Press `UPLOAD` Button + +**Now, press the `upload` buttom. The screen will show this message.** + +
+ +
+ +## 2. Select Networkable AP + +**Use Mobile Phone or PC for connectting to M5Core AP(like `M5Stack-a67c`), and then open brower to login 192.168.4.1 for setting your networkable WIFI name and password. (Now, my networkable wifi is named `MasterHax_5G`)** + +
+ +
+ +## 3. Reset Your Device + +**After connected wifi successfully, reset your core according to the prompt on `192.168.4.1`** + +
+ +
+ +## Complete + +Once you've reset M5Stack Core, pressed the upload buttom, you will arrive at a screen with a QR code. Now, you can try to program with your core following this article [Quick Start with M5Flow](quick_start/m5core/m5stack_core_get_started_MicroPython) + +
+ +
+ +?> **Note** Similarly, if you want another networkable WIFI AP to connect with Core, press the SETUP buttom while core was power-up. + +
+ +
\ No newline at end of file diff --git a/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md b/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md new file mode 100644 index 00000000..ebdf5e4e --- /dev/null +++ b/docs/zh_CN/related_documents/how_to_install_git_and_arduino.md @@ -0,0 +1,23 @@ +# How to install Git and Arduino IDE (Windows) + +## 1. Install `Git` +If you has installed `Git`, please following next setp 2 straight.Otherwise, download the client of [Git](https://git-scm.com/download/win) and install it. + +## 2. Install `Arduino IDE` + +*download address* +https://www.arduino.cc/en/Main/Software + +
+ +
+ +Double click to install Arduino IDE + +
+ +
+ +
+ +
\ No newline at end of file diff --git a/docs/zh_CN/related_documents/upgrade_m5stack_lib.md b/docs/zh_CN/related_documents/upgrade_m5stack_lib.md new file mode 100644 index 00000000..6da8c7a1 --- /dev/null +++ b/docs/zh_CN/related_documents/upgrade_m5stack_lib.md @@ -0,0 +1,17 @@ +# Upgrade M5Stack Lib + +### 1. Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` + +### 2. Type `M5Stack` into the search box, search it. + +
+ Screenshot of coverpage +
+ +### 3. If it shows as below figure, click `Update`. + +**But if it shows `Install`, it means you has not installed M5Stack Lib. So, you need click `Install` for installing lib.** + +
+ Screenshot of coverpage +
diff --git a/docs/zh_CN/sidebar.md b/docs/zh_CN/sidebar.md index 6c5d9a2e..3f0f5f97 100644 --- a/docs/zh_CN/sidebar.md +++ b/docs/zh_CN/sidebar.md @@ -2,6 +2,7 @@ - [快速上手](zh_CN/quick_start) - [API参考](zh_CN/api_reference) - [M5Stack案例](zh_CN/m5stack_cases) +- [相关文档](zh_CN/related_documents) - [常见问题解答](zh_CN/faq)