diff --git a/docs/zh_CN/api_reference.md b/docs/zh_CN/api_reference.md index a0655df4..aadc19ee 100644 --- a/docs/zh_CN/api_reference.md +++ b/docs/zh_CN/api_reference.md @@ -2,6 +2,8 @@ 中文 | [English](/en/api_reference) | [日本語](/ja/api_reference) +*这是MicroPython的编程API* + ## [LCD](zh_CN/api_reference/api_lcd) ## [Peripherals](zh_CN/api_reference/peripherals/api_gpio) ### 1. [GPIO](zh_CN/api_reference/peripherals/api_gpio) diff --git a/docs/zh_CN/product_documents.md b/docs/zh_CN/product_documents.md index fef8b17f..a39938fc 100644 --- a/docs/zh_CN/product_documents.md +++ b/docs/zh_CN/product_documents.md @@ -1,6 +1,6 @@ # 产品列表 -中文 | [English](/en/product_documents) | [日本語](ja/product_documents) +中文 | [English](en/product_documents) | [日本語](ja/product_documents) ?> 每个产品的`快速上手(Quick Start)`部分都放置在了该产品的介绍文档里。 @@ -12,17 +12,17 @@ | [GRAY](zh_CN/product_documents/m5stack-core/m5core_gray) | / | | [FIRE](zh_CN/product_documents/m5stack-core/m5core_fire) | / | | [FACE Kit](zh_CN/product_documents/m5stack-core/face_kit) | / | -| [M5GO IOT Kit](/zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit) | / | +| [M5GO IOT Kit](zh_CN/product_documents/m5stack-core/m5go_iot_starter_kit) | / | | 无线通信模块 | 配件模块 | 控制模块 | | :------------------: |:------------------:| :--------------------:| -| [GPS](/zh_CN/product_documents/modules/module_gps) | [PROTO](/zh_CN/product_documents/modules/module_proto) | [STEPMOTOR](/zh_CN/product_documents/modules/module_stepmotor)| -| [LORA](/zh_CN/product_documents/modules/module_lora) | [BATTERY](/zh_CN/product_documents/modules/module_battery) | [SERVO](/zh_CN/product_documents/modules/module_servo) | -| [SIM800/GPRS/GSM](/zh_CN/product_documents/modules/module_sim800) | [BTC](/zh_CN/product_documents/modules/module_btc) | [COMMU](/zh_CN/product_documents/modules/module_commu) | -| [LoRaWAN](/zh_CN/product_documents/modules/module_lorawan) | [PLUS](/zh_CN/product_documents/modules/module_plus) | / | +| [GPS](zh_CN/product_documents/modules/module_gps) | [PROTO](zh_CN/product_documents/modules/module_proto) | [STEPMOTOR](zh_CN/product_documents/modules/module_stepmotor)| +| [LORA](zh_CN/product_documents/modules/module_lora) | [BATTERY](zh_CN/product_documents/modules/module_battery) | [SERVO](zh_CN/product_documents/modules/module_servo) | +| [SIM800/GPRS/GSM](zh_CN/product_documents/modules/module_sim800) | [BTC](zh_CN/product_documents/modules/module_btc) | [COMMU](zh_CN/product_documents/modules/module_commu) | +| [LoRaWAN](zh_CN/product_documents/modules/module_lorawan) | [PLUS](zh_CN/product_documents/modules/module_plus) | / | | / | / | / | | / | / | / | | / | / | / | @@ -33,9 +33,9 @@ | | | | | :------------------: |:------------------:| :--------------------:| -| [M5GO底座](/zh_CN/product_documents/bases/m5go_base) | [PLC底座](/zh_CN/product_documents/modules/module_plc) | [FACE底座](/zh_CN/product_documents/bases/face_base) | -| [LAN底座](/zh_CN/product_documents/bases/lan_base) | / | / | -| [Node底座](/zh_CN/product_documents/bases/node_base) | / | / | +| [M5GO底座](zh_CN/product_documents/bases/m5go_base) | [PLC底座](zh_CN/product_documents/modules/module_plc) | [FACE底座](zh_CN/product_documents/bases/face_base) | +| [LAN底座](zh_CN/product_documents/bases/lan_base) | / | / | +| [Node底座](zh_CN/product_documents/bases/node_base) | / | / | @@ -72,7 +72,7 @@ | | | | | :------------------: |:------------------:| :--------------------:| -| [BALA](/zh_CN/product_documents/applications/application_bala) | [LidarBot](/zh_CN/product_documents/applications/application_lidarbot) | / | +| [BALA](zh_CN/product_documents/applications/application_bala) | [LidarBot](zh_CN/product_documents/applications/application_lidarbot) | / | diff --git a/docs/zh_CN/product_documents/applications/application_bala.md b/docs/zh_CN/product_documents/applications/application_bala.md index d7f0c574..b5f79385 100644 --- a/docs/zh_CN/product_documents/applications/application_bala.md +++ b/docs/zh_CN/product_documents/applications/application_bala.md @@ -1,53 +1,31 @@ -# M5Stack BALA +# BALA -中文 | [English](/en/product_documents/applications/application_bala) | [日本語](ja/product_documents/applications/application_bala) +中文 | [English](en/product_documents/applications/application_bala) | [日本語](ja/product_documents/applications/application_bala) -## DESCRIPTION +## 描述 -The M5Stack BALA is a balance bot based on M5Stack FIRE, including a 2 DC driver module based on Mega328p which is a core chip on Arduino UNO -You can even program The M5Stack BALA through Arduino or MicroPython with few code +BALA是堆叠了M5Fire，以[M5Fire](https://m5stack.github.io/m5-docs/#/zh_CN/product_documents/m5stack-core/m5core_fire)做主控的平衡车应用，还包括了MEGA328为主控的2路直流电机驱动模块和两个轮子。你可以Arduino或MicroPython编程它。 -The 2 DC driver module communicates with M5Stack FIRE through I2C bus. It's default I2C address is **0x56** +2路直流电机模块与M5Fire之间通过IIC通信，它的IIC地址是**0x56**。 -## FEATURES +## 特性 -- Programming Support - + Python -- Compatible LEGO -- POGO Pin -- TF Card Support +- 支持Arduino编程和Python编程 +- 兼容LEGO +- M5Fire支持插入TF卡 -## PARAMETER - -Model | M5Stack FIRE ----|--- -ESP32 | 240MHz dual core, 600 DMIPS, 520KB SRAM, Wi-Fi, dual mode Bluetooth -Flash | 16MB Flash + 4MB pSRAM -Input | 5V @ 500mA -Interface | TypeC x 1, GROVE(I2C+I/0+UART), Pogo Pin x 1 -LCD | 2 inch, 320x240 Colorful TFT LCD, ILI9342 -Speaker | 1W-0928 -Microphone | MEMS Analog BSE3729 Microphone -LED | SK6812 3535 RGB LED x 10 -MEMS | MPU9250 (MPU6500 + AK8963) -Battery | 550mAh @ 3.7V, inside -Op.Temp. | 32°F to 104°F ( 0°C to 40°C ) -Size | 54 x 54 x 21 mm -C.A.S.E | Plastic ( PC ) -Weight | 56g - -## INCLUDES +## 包括 - 1x M5Stack BALA -- 1x Motor Driver -- 2x N20(Encoder included) -- Type-C USB Cable +- 1x 电机驱动 +- 2x 带编码器的N20电机 +- Type-C USB线 -## DOCUMENTS -- **Example** - [Arduino](https://github.com/m5stack/M5Bala/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5Bala/tree/master/mpy) -- **[QuickStart](https://github.com/m5stack/M5Bala)** -- **[Purchase](https://www.aliexpress.com/store/product/M5Satck-New-BALA-Car-ESP32-Development-Mini-Electric-Self-balancing-Car-2DC-Motor-with-Encoder-PSRAM/3226069_32904033658.html?spm=2114.12010615.8148356.40.1fd3724dW3O2Bu.html)** +## 相关链接 +- **例程** - [Arduino](https://github.com/m5stack/M5Bala/tree/master/examples) - [MicroPython](https://github.com/m5stack/M5Bala/tree/master/mpy) +- **[上手指南](https://github.com/m5stack/M5Bala)** +- **[购买链接](https://www.aliexpress.com/store/product/M5Satck-New-BALA-Car-ESP32-Development-Mini-Electric-Self-balancing-Car-2DC-Motor-with-Encoder-PSRAM/3226069_32904033658.html?spm=2114.12010615.8148356.40.1fd3724dW3O2Bu.html)**
diff --git a/docs/zh_CN/product_documents/applications/application_lidarbot.md b/docs/zh_CN/product_documents/applications/application_lidarbot.md index 86706ff3..a83b4810 100644 --- a/docs/zh_CN/product_documents/applications/application_lidarbot.md +++ b/docs/zh_CN/product_documents/applications/application_lidarbot.md @@ -1,6 +1,6 @@ # LidarBot -中文 | [English](/en/product_documents/applications/application_lidarbot) | [日本語](ja/product_documents/applications/application_lidarbot) +中文 | [English](en/product_documents/applications/application_lidarbot) | [日本語](ja/product_documents/applications/application_lidarbot) ## 描述 diff --git a/docs/zh_CN/product_documents/tools/tool_usb_downloader.md b/docs/zh_CN/product_documents/tools/tool_usb_downloader.md index b3132936..b3b6a6b8 100644 --- a/docs/zh_CN/product_documents/tools/tool_usb_downloader.md +++ b/docs/zh_CN/product_documents/tools/tool_usb_downloader.md @@ -1,13 +1,11 @@ # M5Stack USB Downloader -中文 | [English](/en/product_documents/tools/tool_usb_downloader) | [日本語](ja/product_documents/tools/tool_usb_downloader) +中文 | [English](en/product_documents/tools/tool_usb_downloader) | [日本語](ja/product_documents/tools/tool_usb_downloader) ## 描述 内置CP2104芯片的串口转USB烧录工具，使用这款工具，能自动烧录固件。 -TXD led, RXD led, Power led and 6pin @ 2.54mm bus sockets. - ## 参数 | 管脚号 | 管脚名字 | diff --git a/docs/zh_CN/quick_start/bala/bala_quick_start.md b/docs/zh_CN/quick_start/bala/bala_quick_start.md index ab35a773..b051280c 100644 --- a/docs/zh_CN/quick_start/bala/bala_quick_start.md +++ b/docs/zh_CN/quick_start/bala/bala_quick_start.md @@ -2,4 +2,4 @@ 中文 | [English](en/quick_start/bala/bala_quick_start) | [日本語](ja/quick_start/bala/bala_quick_start) -## (coming soon...) \ No newline at end of file +## (在编辑中...) \ No newline at end of file diff --git a/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md b/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md index dc025d8f..cdd75db2 100644 --- a/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md +++ b/docs/zh_CN/quick_start/m5camera/m5camera_quick_start.md @@ -2,32 +2,32 @@ 中文 | [English](en/quick_start/m5camera/m5camera_quick_start) | [日本語](ja/quick_start/m5camera/m5camera_quick_start) -## 1. Out-of-the-box Demo +## 1. 开箱即用的Demo -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. +*如果你拿到摄像头模块之后，不需要写任何代码即可能看到摄像头拍摄的图像。* + +1. 向ESP32Cam/M5Camera插入USB线以供电，然后打开电脑的串口终端。
-2. Then waitting a few seconds, you connect to a AP named "`M5CAM`" with your computer(or mobile phone). +2. 等待几秒之后，用电脑连接名为`M5CAM`的热点。
-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. +3. 打开浏览器，访问网址`http://192.168.4.1`。 此时，即可看到ESP32Cam/M5Camera实时传输的图像。
-Now, A WebCam you achieved successfully ! +*注意:* -*Note:* - -ESP32CAM AP only can connect with one device at a time. +ESP32CAM的热点一次只能连接一台电脑 \ 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 index 3ff41dd8..1b0c2704 100644 --- 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 @@ -1,20 +1,22 @@ -# How to install Git and Arduino IDE (Windows) +# 安装Git和Arduino IDE (Windows) -中文 | [English](/en/related_documents/how_to_install_git_and_arduino) | [日本語](ja/related_documents/how_to_install_git_and_arduino) +中文 | [English](en/related_documents/how_to_install_git_and_arduino) | [日本語](ja/related_documents/how_to_install_git_and_arduino) -## 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. +## 1. 安装`Git` +如果你已经安装了`Git`，请直接从第2步开始。 -## 2. Install `Arduino IDE` +否则点击这里下载[Git](https://git-scm.com/download/win)并安装它 -*download address* +## 2. 安装`Arduino IDE` + +*下载地址* https://www.arduino.cc/en/Main/Software
-Double click to install Arduino IDE +双击安装Arduino IDE，全程保持默认的选择，包括安装路径也是默认。
diff --git a/docs/zh_CN/related_documents/upgrade_m5stack_lib.md b/docs/zh_CN/related_documents/upgrade_m5stack_lib.md index 17af843e..81d30340 100644 --- a/docs/zh_CN/related_documents/upgrade_m5stack_lib.md +++ b/docs/zh_CN/related_documents/upgrade_m5stack_lib.md @@ -1,18 +1,18 @@ -# Upgrade M5Stack Lib +# 升级M5Stack库(Arduino IDE Library) -中文 | [English](/en/related_documents/upgrade_m5stack_lib) | [日本語](ja/related_documents/upgrade_m5stack_lib) +中文 | [English](en/related_documents/upgrade_m5stack_lib) | [日本語](ja/related_documents/upgrade_m5stack_lib) -### 1. Start up Arduino IDE, then Select `Sketch`->`Include Library`->`Manage Libraries...` +### 1. 打开Arduino IDE，然后点击`Sketch`->`Include Library`->`Manage Libraries...` -### 2. Type `M5Stack` into the search box, search it. +### 2. 在搜索框输入`M5Stack`，并搜索
Screenshot of coverpage
-### 3. If it shows as below figure, click `Update`. +### 3. 如果显示如下，则点击`Update`. -**But if it shows `Install`, it means you has not installed M5Stack Lib. So, you need click `Install` for installing lib.** +**但是如果显示`Install`，这意味着你之前还没安装M5Stack库，所以点击`Install`进行安装。**
Screenshot of coverpage